-
Notifications
You must be signed in to change notification settings - Fork 81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix all 404 links #229
Fix all 404 links #229
Conversation
✅ Deploy Preview for docssigstore ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Note: This is strongly not recommended!Please try to solve this problem by Hugo engine.This is equivalent to tampering with all your routes once. This will cause all existing Sigstore materials and external links to be unable to get the correct jump. (In fact, this is a bug left over from migrating Hugo) In addition, if the existing document address is changed, it does not look elegant. For a docs second-level domain, there is still a docs on the route, except that it brings extra operational burden to people like + https://docs.sigstore.dev/docs/about/tooling/
- https://docs.sigstore.dev/about/tooling/ |
In principle, this is absolutely correct. Moving all of the URLs down to docs will break most external links to the site. However, I'll note that the site has undergone a major content reorganization as of last week, and among those changes is the renaming of (I think) every resource category. For example, many of the resources that were once under "cosign" are now under "signing." When the Hugo migration was undertaken, only perhaps 4-5 links had the same URLs (about half of the items now under "about"). About 20% of the link fixes in this PR are actually internal links not updated during the content migration. If more than a handful of links hadn't been reorganized, I agree that it would make sense to invest the effort to remove the "docs" level from the hierarchy. If there's interest in this expressed here, I can undertake to do that. However, I'll note that the Doks theme does hard-code behavior based on the presence of a docs folder, so this effort is more like creating our own theme, in terms of upfront effort and ongoing maintenance. Thanks for this comment. I'm sympathetic to this as someone who has worked in libraries and favors backward compatibility. I'm curious to know what other thoughts there are on this issue, or what you think of the above. tl;dr Most URLs have already changed before the Hugo migration, maybe 95%. |
Maybe you can consider trying Slug? |
@normal-coder — we addressed this in a recent info architecture change, but the extensive re-platform lost some of these files which we should bring back, I agree! I created an issue to track: #230 |
Unfortunately, sections cannot be changed with front matter, and Hugo really wants the site organization to reflect folder organization. With that said, and even though most external links will not be backwards compatible after the reorganization anyway, , I do find the inclusion of a "docs" section to be redundant for our site, which is entirely a docs site. I think I have come up with a way to do this, but it will take some more development work. For now, I will leave this PR as-is, but it should not be merged. If I can reorganize the site to not include a superfluous "docs" on the path, I will, and will create a PR for that. If that is successful, I will revise this PR to include only those links that were broken for reasons unrelated to the inclusion of "docs" on the path. Thanks, @normal-coder , appreciate the thoughts here. |
I renamed with "WIP" for "work in progress" @smythp if you can change the flag when this is ready for review. Thanks! |
Removed the docs folder and moved all content up one level Added necessary front matter to all content files, as Doks depended on the docs folder to determine the template used Updated archetype with correct front matter for furture file creation Rewrote sidebar template to use new folder structure Resolves sigstore#231 References sigstore#229 Signed-off-by: Patrick Smyth <[email protected]>
* Removed docs from URL path Removed the docs folder and moved all content up one level Added necessary front matter to all content files, as Doks depended on the docs folder to determine the template used Updated archetype with correct front matter for furture file creation Rewrote sidebar template to use new folder structure Resolves #231 References #229 Signed-off-by: Patrick Smyth <[email protected]> * Changed FlexSearch params to reflect new structure Signed-off-by: Patrick Smyth <[email protected]> --------- Signed-off-by: Patrick Smyth <[email protected]>
Added link to Slack invite Changed link to external Slack community Resolves sigstore#228 Signed-off-by: Patrick Smyth <[email protected]>
Fixed trailing whitespace, spaces around headings and lists, consistent lists Updated another link to Slack Signed-off-by: Patrick Smyth <[email protected]> More markdown fixes Signed-off-by: Patrick Smyth <[email protected]> More linting Signed-off-by: Patrick Smyth <[email protected]>
OK, fixed the links and linted the pages I touched. In theory, there should be no current broken links on the site after this is merged. |
Signed-off-by: ltagliaferri <[email protected]>
All links on the docs site that resolved to 404 now lead somewhere
Some links changed to more useful or up-to-date links
Added link to Slack invite
References #43
Resolves #228